home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / rexxc / findaminet.doc < prev    next >
Text File  |  1996-09-07  |  5KB  |  144 lines
  1.  
  2.         FindAminet 1.15 for AmiFTP
  3.  
  4.         © 1996 Sami Itkonen
  5.  
  6.  
  7.         Purpose:
  8.  
  9. To find and get files from Aminet with AmiFTP, using Aminet findservers which exist in 
  10. some Aminet sites.
  11.  
  12.  
  13.         Requirements:
  14.  
  15. AmigaOS 2.04 or higher
  16. AmiFTP 1.149 or higher
  17. AmiTCP installed since the script needs the TCP:-device
  18. rexxreqtools.library   (At the time of writing aminet:util/rexx/rexxreqtools.lha, also
  19.             part of the reqtools distribution)
  20. rexxdossupport.library (.. aminet:util/rexx/RexxDosSupport.lha)
  21. amigaguide.library
  22.  
  23.  
  24.         Installation:
  25.  
  26. copy Find.AmiFTP rexx:
  27. protect rexx:Find.AmiFTP +s
  28.  
  29.  
  30.         Usage: 
  31.  
  32. [rx] Find.AmiFTP [-e] ["substring"|"substrings"] [-m<maxhits>] [-s<sitename>] [-p<portname>] 
  33.          [-f<findsite number>] [-w<width>] [-c<0|1>]
  34.  
  35. Explanation of the options: 
  36.         -e      - tells the Aminet findserver to look for the exact string
  37.         -m<maxhits> - defines the maximum number hits the findserver should return.
  38.         -s<sitename> - the Aminet site to use
  39.         -p<portname> - The Arexx portname of AmiFTP FindAminet
  40.         -f<findsite number> - the number of the findsite to use (more on this below)
  41.         -w<width> - the width of the lines the findserver should return (not all
  42.             findservers understand this command)
  43.         -c<0|1> - will force crap filtering on (1) or off (0). Any other number will
  44.             be ignored.
  45.  
  46. Arguments can be freely mixed on the command line. Any argument not beginning with a hyphen ('-') 
  47. will be taken as a part of the string to find. If no string is specified, you will be prompted
  48. with a reqtools requester to enter a string. You can enter options in that requester, too.
  49. If any files are found, an amigaguide file will be popped up (See section Getting files).
  50.  
  51.  
  52.         Configuration:
  53.  
  54. The following variables can be configured (by editing the script) for customization:
  55.  
  56. dldir         - Your default download directory
  57. AmiFTP_bin     - The full path to your AmiFTP binary. Set this if you don't have 
  58.           AmiFTP in your command path.
  59. sitename    - The default Aminet site to use
  60. pubscreen    - The public screen to use
  61. viewmethod    - Defines the method to 'view' downloaded files. 'builtin' will try
  62.           to use AmiFTP's builtin VIEW command (more on this in the AmiFTP
  63.           documentation). 'processfile' will use 'rexx:processfile.rexx', which
  64.           comes with eg. Grapevine. Any other setting will disable viewing.
  65. filtercrap    - If set to 1, will filter out all files in directories that match 
  66.           'filterpat', which is a valid AmigaDOS pattern.
  67. filterpat    - The pattern to filter out files in unwanted directories.
  68. width        - The default display width
  69. maxhits        - The default number of maximum hits
  70. fsitenum    - The number of the default Aminet findsite. Possible choices are:
  71.             1 - Using site ftp.wustl.edu
  72.             2 -     ...    amiga.icu.net.ch
  73.             3 -     ...    haegar2.uni-paderborn.de
  74.  
  75.  
  76.         Getting files:
  77.  
  78. Whether the script finds files or not, it will popup an amigaguide file containing
  79. the hits. If there are none, there will only be a gadget named 'Search for a new file',
  80. which will call Find.AmiFTP script again. The Aminet site and findsite used and the portname
  81. for the script will be propagated to next script. 
  82. Those files found will be in the following format:
  83.  
  84. [     Filename        ]    Directory  Size  Age¹ [ Description ]
  85.  
  86. Clicking on the 'filename' gadget will download the file and optionally try to
  87. view/process it, depending on the 'viewmethod' configuration variable. Clicking
  88. on 'description' gadget will download and view the Readme of the file.
  89.  
  90. ¹) Some findsites do not supply this
  91.  
  92.  
  93.         Disclaimer:
  94.  
  95. This software is provided as it is. I cannot be held responsible for any damage
  96. that will happen to your computer, you or your state of mind. 
  97.  
  98. Any funny remarks in this file are completely unintentional.
  99.  
  100.  
  101.         Credits:
  102.  
  103. Thanks go to:
  104.  
  105. Osma Ahvenlampi for writing Browse.DaFTP and other cool stuff 
  106. Josef Faulkner for writing aminetfind.gvrexx
  107. Magnus Lilja for AmiFTP
  108. Commodore for making such a mess of everything
  109. Douglas Adams - not that he had anything to with the script or Amiga at all, but 
  110.     Hitchhiker's Guide to the Galaxy is a great book, don't you think?
  111.  
  112.  
  113.         Contacting the Author:
  114.  
  115. Email: Sami.Itkonen@hut.fi
  116. IRC: Camelot (in undernet)
  117.  
  118.     
  119.         Find.AmiFTP version history:
  120.     
  121. 1.15
  122.     - Added the -c option for switching crap filter on/off
  123.     - fixed the bug with the crap filter
  124.     - Removed the very incomplete 'History' section from the doc file :)
  125. 1.14
  126.     - Added the view method 'builtin'
  127.  
  128. 1.13
  129.     - Added the viewmethod configuration variable
  130.  
  131. 1.12
  132.     - Options can now be freely mixed in the command line
  133.     - haegar2 (findsite) doesn't show age field, files found from there are now shown correctly
  134.  
  135. 1.11    
  136.     - Changed the 'exact' keyword to the '-e' option
  137.  
  138. 1.10    
  139.     - All requesters/guide now use the supplied public screen
  140.  
  141. 1.9
  142.     - Findsite didn't propagate from one script to another, fixed that bug
  143.  
  144.